std::valarray

From Cppreference

C++ Standard Library
Language Utilities library Strings library Containers library Algorithms library Iterators library Numerics library Input/output library Localizations library Regular expressions library (C++11) Atomic operations library (C++11) Thread support library (C++11)
Numerics library
Common mathematical functions Floating-point environment Complex numbers Numeric arrays Pseudo-random number generation Generic numeric operations iota (C++11) accumulate inner_product adjacent_difference partial_sum
Numeric arrays
Template:cpp/numeric/valarray/sidebar content

Defined in header <valarray>
template< class > class valarray;

std::valarray is the class for representing and manipulating arrays of values. It supports element-wise mathematical operations and various forms of generalized subscript operators, slicing and indirect access. std::valarray and helper classes are defined to be free of certain forms of aliasing, thus allowing operations on these classes to be optimized.

Contents 1 Member types 2 Member functions 3 Non-member functions 4 Helper classes

[edit] Member types

Member type	Definition
value_type	T

[edit] Member functions

(constructor)	constructs new valarray (public member function)
(destructor)	destructs the valarray (public member function)
operator=	replaces the contents of valarray (public member function)
operator[]	get/set valarray element, slice, or mask (public member function)
operator+ operator- operator~ operator!	applies a unary arithmetic operator to each element of the valarray (public member function)
operator*= operator/= operator%= operator+= operator-= operator^= operator&= operator|= operator<<= operator>>=	applies compound assignment operator to each element of the valarray (public member function)
swap	swaps with another valarray (public member function)
size	returns the size of valarray (public member function)
resize	changes the size of valarray (public member function)
sum	calculates the sum of all elements (public member function)
min	returns the smallest element (public member function)
max	returns the largest element (public member function)
shift	zero-filling shift the elements of the valarray (public member function)
cshift	circular shift of the elements of the valarray (public member function)
apply	applies a function to every element of a valarray (public member function)

[edit] Non-member functions

std::swap (C++11)	specializes the std::swap() algorithm (function template)
operator* operator/ operator% operator+ operator- operator^ operator& operator| operator<< operator>> operator&& operator	applies binary operators to each element of two valarrays, or a valarray and a value (function template)
operator== operator!= operator< operator> operator<= operator>=	compares two valarrays or a valarray with a value (function template)
asin acos atan atan2 cos cosh sin sinh tan tanh	applies trigonometric functions to each element of a valarray (function template)
abs	applies the function std::abs to each element of valarray (function template)
exp	applies the function std::exp to each element of valarray (function template)
log	applies the function std::log to each element of valarray (function template)
log10	applies the function std::log10 to each element of valarray (function template)
pow	applies the function std::pow to two valarrays or a valarray and a value (function template)
sqrt	applies the function std::sqrt to each element of valarray (function template)
begin (C++11)	returns a RandomAccessIterator to the first element of the valarray (function template)
end (C++11)	returns a RandomAccessIterator one past the last element of the valarray (function template)

[edit] Helper classes

slice	BLAS-like slice of a valarray: starting index, length, stride (class)
slice_array	proxy to a subset of a valarray after applying a slice (class template)
gslice	generalized slice of a valarray: starting index, set of lengths, set of strides (class)
gslice_array	proxy to a subset of a valarray after applying a gslice (class template)
mask_array	proxy to a subset of a valarray after applying a boolean mask operator[] (class template)
indirect_array	proxy to a subset of a valarray after applying indirect operator[] (class template)